Vcenter FoundationLoadBalancers Info

Vcenter FoundationLoadBalancers Info
Vcenter FoundationLoadBalancers Info

The Vcenter FoundationLoadBalancers Info schema defines information about load balancer.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "id": "string",
    "name": "string",
    "owner": "string",
    "owner_id": "string",
    "replica": 0,
    "size": {
        "reserve_cpu": false,
        "reserve_mem": false,
        "size": "string"
    },
    "available_versions": [
        {
            "major": 0,
            "minor": 0,
            "patch": 0,
            "revision": 0
        }
    ],
    "version": {
        "major": 0,
        "minor": 0,
        "patch": 0,
        "revision": 0
    },
    "placement_spec": {
        "cluster": "string",
        "res_pool": "string",
        "storage_policy": "string",
        "folder": "string"
    },
    "network_config_spec": {
        "ntp_servers": [
            "string"
        ],
        "dns": {
            "servers": [
                "string"
            ],
            "search_domains": [
                "string"
            ]
        },
        "extra_vip_subnets": [
            "string"
        ]
    },
    "log_config_spec": {
        "log_verbosity": "string",
        "syslog_server": "string"
    },
    "load_balancer_controllers": [
        {
            "address": "string",
            "port": 0
        }
    ],
    "node_info_map": {
        "node_info_map": {
            "id": "string",
            "version": {
                "major": 0,
                "minor": 0,
                "patch": 0,
                "revision": 0
            },
            "nics": [
                {
                    "ip_settings": [
                        {
                            "type": "string",
                            "ip_address": "string",
                            "prefix": 0,
                            "personas": [
                                "string"
                            ],
                            "gateway": "string"
                        }
                    ],
                    "network": "string",
                    "device_id": "string"
                }
            ],
            "node_runtime_info": {
                "vm": "string",
                "maintenance_mode": "string",
                "management_ip": "string",
                "deployment_status": "string",
                "deployment_notifications": [
                    {
                        "severity": "string",
                        "title": "string",
                        "message": "string",
                        "time": "string"
                    }
                ],
                "ha_status": "string",
                "health_status": "string",
                "health_notifications": [
                    {
                        "severity": "string",
                        "title": "string",
                        "message": "string",
                        "time": "string"
                    }
                ],
                "workload_alarms": [
                    {
                        "severity": "string",
                        "title": "string",
                        "message": "string",
                        "time": "string"
                    }
                ],
                "utilization": {
                    "cpu": "string",
                    "memory": "string"
                }
            }
        }
    },
    "trusted_ca": {
        "cert_chain": [
            "string"
        ]
    },
    "runtime": {
        "operation_status": "string",
        "operation_notifications": [
            {
                "severity": "string",
                "title": "string",
                "message": "string",
                "time": "string"
            }
        ],
        "deployment_status": "string",
        "health_status": "string",
        "utilization": {
            "cpu": "string",
            "memory": "string"
        }
    },
    "system_trusted_cas": [
        {
            "cert_chain": [
                "string"
            ]
        }
    ]
}
string
id
Required

The identifier of the load balancer.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancer. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancer.

string
name
Required

The name of the load balancer.

This property was added in vSphere API 9.0.0.0.

string
owner
Required

The owner of the load balancer.

This property was added in vSphere API 9.0.0.0.

string
owner_id
Optional

The owner identifier of the load balancer.

This property was added in vSphere API 9.0.0.0.

If missing or null, it means the owner identifier is not configured when creating the load balancer.

integer As int64 As int64
replica
Required

The replica number of the load balancer node(s).

This property was added in vSphere API 9.0.0.0.

size
Required

The load balancer node(s) capacity.

This property was added in vSphere API 9.0.0.0.

available_versions
Optional

The available versions could be used for upgrading.

This property was added in vSphere API 9.0.0.0.

If missing or null means there are no versions for upgrading.

version
Required

The version of load balancer image.

This property was added in vSphere API 9.0.0.0.

placement_spec
Required

The placement configuration of load balancer node(s).

This property was added in vSphere API 9.0.0.0.

network_config_spec
Required

The network configuration of load balancer node(s).

This property was added in vSphere API 9.0.0.0.

log_config_spec
Optional

The log configuration of load balancer node(s).

This property was added in vSphere API 9.0.0.0.

If missing or null means doesn't configure log setting when creating load balancer.

load_balancer_controllers
Optional

The location of load balancer controller.

This property was added in vSphere API 9.0.0.0.

If missing or null means doesn't configure load balancer controller when creating load balancer.

object
node_info_map
Required

The load balancer node(s) information, the key(ID) was dynamically generated when creating the load balancer node and it will stick with the load balancer node during the whole lifecycle, even if you make changes to the load balancer node, such as reconfiguration and redeployment.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancerNode. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.FoundationLoadBalancerNode.

trusted_ca
Optional

The TLS certificate chain of the load balancer used by load balancer node(s) to verify the load balancer controller.

This property was added in vSphere API 9.0.0.0.

If missing or null, load balancer node(s) use system-wide certificates finishing the verification process for load balancer controller.

runtime
Required

The runtime information associated with load balancer.

This property was added in vSphere API 9.0.0.0.

system_trusted_cas
Optional

List of trusted CA certificate chains used by load balancer node(s) for verifying the TLS certificates. These certificate chains are imported into the system-wide database to secure TLS connections of load balancer node(s).

This property was added in vSphere API 9.0.0.0.

If missing or null, the system certificate store of the load balancer node(s) will remain empty.